/*!	 boneweightpair.h
**	 A weighted bone
**
**	Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
**	Copyright (c) 2008 Chris Moore
**
**	This package is free software; you can redistribute it and/or
**	modify it under the terms of the GNU General Public License as
**	published by the Free Software Foundation; either version 2 of
**	the License, or (at your option) any later version.
**
**	This package is distributed in the hope that it will be useful,
**	but WITHOUT ANY WARRANTY; without even the implied warranty of
**	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
**	General Public License for more details.
**
*/

#ifndef __SYNFIG_BONE_WEIGHT_PAIR_H
#define __SYNFIG_BONE_WEIGHT_PAIR_H

#include "real.h"
#include "string.h"
#include "bone.h"
#include <ETL/stringf>

namespace synfig
{

// class ValueNode_Bone;

/*!	\class BoneWeightPair
**	TODO:  writeme
*/
class BoneWeightPair
{
private:
    Bone bone;
    Real weight;

public:
    BoneWeightPair(): weight() {}
    BoneWeightPair(Bone bone, Real weight): bone(bone), weight(weight) { }

    Real get_weight()const
    {
        return weight;
    }
    Bone get_bone()const
    {
        return bone;
    }

    // Get the string of the BoneWeightPair
    // @return String type. A string representation of the two components.
    String get_string()const
    {
        return etl::strprintf("(%.2f) %s", weight, bone.get_name().c_str());
    }
};

}; // END of namespace synfig

#endif